Love this PR.

I've experienced that for some use cases I would like the open and close methods. For some it was better if I could set is_open=True or is_open=False. Please consider the last feature :-)

@MarcSkovMadsen I also missed these two methods in panel_modal. I ended up using modal._show().

When adding documentation please consider if request awesome-panel/panel-modal#3 should be part of the docs. Thx.

One thing to consider is if the Modal could be made easier to use? Could the api of the Modal be generalized to a concept of actions/ action buttons.

Could the api be simplified?

The api of panel-modal that I made is:

import panel as pn

from panel_modal import Modal

pn.extension("modal")

modal = Modal(pn.panel("Hi. I am the Panel Modal!", width=200))

pn.Column(modal.param.open, modal).servable()

It requires you define a variable holding the Modal and include both the button (modal.param.open) and the modal modal.

If you want to customize the button it requires something like pn.widgets.Button.from_param(modal.param.open as well.

Could the api be simplified? Could it be enough to just include the modal?

import panel as pn

from panel_modal import Modal

pn.extension("modal")

pn.Column(
    Modal(pn.panel("Hi. I am the Panel Modal!", width=200))
).servable()

That should show the button. And when clicked the modal should open/ close. That would make it much simpler to drop in as you don't need to define a variable holding the Modal.

If you want to customize the button you can just do:

import panel as pn

from panel_modal import Modal

pn.extension("modal")

pn.Column(
    pn.widgets.Button.from_param(
        Modal(
            pn.panel("Hi. I am the Panel Modal!", width=200),
        ),
        button_style="outline",
    )
)
).servable()

If you want to trigger the modal from something else than a Button than you should be able to hide the button:

import panel as pn

from panel_modal import Modal

pn.extension("modal")

modal = Modal(..., visible=False)

...

def trigger_modal():
    modal.open=True

pn.Column(
    modal,
    .....
).servable()

Could the API be generalized?

A Modal is actually a part of a general concept for action buttons. You want to be able to trigger an action via a Button. You want to be able to easily set the source or target (object) and be able to customize the button.

modal_button = ModalButton(object=pn.panel(...))
copy_text_button= CopyToClipboardButton(object="...my code")
copy_dataframe_button= CopyToClipboardButton(object=df) # df is a dataframe
paste_button = PasteFromClipboardButton(object=pn.widgets.Tabulator) # Here the object is the target. Not the source.
link_button = OpenLinkButton(object="https://panel.holoviz.org, target="_blank")
maximize_content = pn.Column(...)
maximize_button = MaximizeButton(object=maximize_content) # Maximizes the object to full window size
...

I've had in the back of my head that I wanted to create a panel-action-buttons package one day. Compiling these as I use those for my work app all the time.

@philippjfr. What do you think?